Home
If you are reading this from a PDF file, you can get the latest copy of the documentation from this link
Welcome to the NextGen Testing Platform wiki! A Description of our pages are as follows:
- Installation Pre-requisites: Details on installation and configuration of platform pre-requisites such as java, maven, and IntelliJ IDE
- Framework Installation: Details on downloading the framework from GitHub and installing into your IDE
- Getting Started with NGTP: Details and illustrations on how to work with Next Gen Testing Platform (NGTP)
- UI Installation: Details on downloading the NGTP UI and installing it
- Getting Started with NGTP UI: Details and illustrations on how to work with NGTP UI
- GitHub Usage Guidelines How to subscribe yourself to get updates on the most recent changes to NGTP
- Setting up CI Pipelines: Guide on setting up GitHub Actions CI Pipelines
- Product Versioning: Guide on versioning practices to be followed for NGTP updates and releases
- Integrations: How to integrate with common 3rd party software
- Troubleshooting: Common pitfalls and how to avoid them and fix them
Installation Prerequisites
Hardware/Software Requirements
| S.no |
Requirement |
Minimum |
Recommended |
Special Cases |
| 1 |
Processor |
Dual-Core |
Intel i5 |
Intel i7 or quad core for Data/ETL validations |
| 2 |
RAM |
8GB |
16GB |
32GB or more for Data/ETL validations/ Mac book Pro 32GB preferable |
| 3 |
Elevated access |
Temporary |
Extended for Testing IE websites |
- |
Install Java JDK
There are 2 options for Java installation
Note: Use Open JDK, unless there is an explicit requirement to use Oracle JDK, as it comes with no-strings-attached and is completely open source.
Open JDK
Install OpenJDK14 or above LTS version from here
JDK 14 or above will be the most compatible. Always use Long Term Support (LTS) versions (jdk 11, 14).
Oracle JDK
- IMPORTANT NOTE: You must request the “Java Uninstall Exception 1.0” software or else
java may be uninstalled from your computer by EY
- In order to request the exception follow the following directions:
- Go to the EY Appstore (https://ey.service-now.com/ey/) → Go to “Order Something” → click “Get Software” → Search “Java Uninstall Exception 1.0” → click “request”
- Install JDK 14 from https://www.oracle.com/java/technologies/javase-downloads.html
- JDK 11 or above will be the most compatible. Always use Long Term Support (LTS) versions (JDK8, JDK11, JDK14)
Install Maven
- Download latest version of apache-maven from here
- Unzip the archive to a folder in your local machine
- Versions as old as 2.2 have been tested and work correctly. But we will not support any deprecations and you will have to update to the newer versions
**How to set New Environment Variables:**
1. Click the file explorer icon on your computer
2. Right click on "This PC" and select the "Properties" option
3. Click on advanced system settings
4. On the Advanced tab, select Environment Variables, and then click new
5. Furnish the variable name and path. Click OK
Version Control System
Subversion
Download and install Tortoise SVN from TortoiseSVN
- Select the latest available stable version for your machine to download (64 bit)
- Run the program once downloaded and click next through the setup until the custom setup page.
- Click command line client tools and make sure it is set to "Entire feature will be installed on local hard drive"
- Click install and click finish
Subversion Code Checkout
- Create a new folder wherever you want to maintain the project repository. Name it as per your preference.
- Right click the created folder and click svn checkout
- Enter the URL for the repository and click ok
- Wait for the download and then verify the folder is not empty
or,
Git
Internally, we use GitHub within EY. So this must be your choice if you are installing NGTP within EY network.
- Download Github for desktop app or integrate Git to your IDE
- Download Git from here and install it.
- In IntelliJ, File -> Settings ->Version Control ->Git and set the path for the executable
Note: For the merge, fork, mirror, PR and general Github best practices refer the Github guidelines document.
Setup Environment Variables
Setup new variables – Click New
- JAVA_HOME: - e.g C:\softwares\jdk-14.0.2
- MAVEN_HOME: -e.g C:\maven\apache-maven-3.6.3
- M2_HOME: -e.g %MAVEN_HOME%
- M2_REPO: -e.g C:\Users\.m2\repository
- LICENSE_PATH: -e.g C:\Users\\licenses\NGTP\license.bin
Add the following to your Path variable if not present already
- Maven Bin folder – e.g: %MAVEN_HOME%\bin
- Java Bin folder – e.g: %JAVA_HOME%\bin
Note: If you have any other versions of java in your path variables, either remove them or move them down below the above Java path we just set.
Test if everything works
- To test if everything is working go to command prompt and type the following
commands to verify the installation and versions are all correct:
where javajava -versionwhere mavenmaven -version
Note: All of them should give the versions of the most recently installed software. If not revisit the steps above and check if you missed any.
Download and setup IntelliJ Community Version and its dependencies
- Download IntelliJ Community Version and its dependencies from https://www.jetbrains.com/idea/download/#section=windows
- Click next through all the setup instructions. Click finish at the end. Required version:
2019.2.2 or later
- In order for NG Testing Platform to run correctly in your IntelliJ environment, be sure to
install the following plugins from the IntelliJ Marketplace:
- Cucumber for Java Plugin for IntelliJ (IntelliJ Idea Marketplace, Open IntelliJ → File → Settings → Plugins)
- Recommended Version: latest
- Gherkin Plugin for IntelliJ (IntelliJ Idea Marketplace, Open IntelliJ → File → Settings → Plugins)
- Recommended Version: latest
- YAML/ANSIBLE Plugin for IntelliJ (IntelliJ Idea Marketplace, Open IntelliJ File → Settings → Plugins)
- Recommended Version: latest
Configuring your IntelliJ to SSO into GitHub (Internal only)
In order for you to clone your projects, push and pull from GitHub every time without having to enter your user name password, you need to configure Secure Shell (SSH) on your machine and provide GitHub with that details. This will enable GitHub and your machine to communicate securely without you needing to authorize yourself. More details on this can be found here
The GitHub website has laid down the steps to generate an SSH key. Please follow the instructions diligently to set up SSH and add the key to your GitHub Settings. Do not forget to enable SSO after creating SSH. Once you have done this, you will be able to clone the projects using SSH links instead of the https URLs.
Now, navigate to File -> Settings -> Version Control and select GitHub. Click the + sign on the right side and select Login via GitHub option and follow the prompts to get SSO access to GitHub from IntelliJ. Below the window, check the checkbox that says:
- [x] clone git repositories using ssh.
Obtaining and Configuring NGTP License
Activation Required
The library is license restricted with a digitally-signed EY license. You will need a license file or, a license token added to your environment variables to activate the tool. Get a limited duration license from our NGTP License Administrators. Email them the following details to help create your license
- Your full name
- Business case
- Engagement duration (for client projects)
If given a license file,it to a secure location in your file system and note down the path. Provide the path in your environment variables in the below format. Details are provided in the above.
| Key |
Value |
| LICENSE_PATH |
YOUR LICENSE FILE PATH |
Note: Alternative way if you cannot access environment variables, if you are running locally in IntelliJ, you can go to Edit configurations > Environment Variables (under configuration tab) and save the key value pair as LICENSE_PATH=
Setting up NGTP
Understanding the NGTP layout
As mentioned earlier, Next Gen Testing Platform is a modular test harness: it needs the following to function:
- Atleast 1 core library (etaf-core-library, etl-core-libraries etc)
- The corresponding step-definitions library (etaf-step-definitions, etl-step-definitions etc)
- And the cherry-on-top, the actual test automation framework which in itself is essentially a shell which needs its above libraries to be fully-functional. There are different libraries for doing different things with this framework. Namely,
- etaf-step-definitions: Provides all the reusable steps needed for functional, UI and system testing of web applications
- etaf-core-libraries: Provides the capabilities required by etaf-step-definitions to enable Web app testing
- etl-step-definitions: Provides all the reusable steps needed for data and ETL testing
- etl-core-libraries: Provides the capabilities required by etl-step-definitions to enable data and ETL testing
and many more. Please refer the wiki links for other such component libraries.
To configure your project to consume these libraries you need to add either the library dependencies to your pom.xml and cofiguring your maven settings.xml or, their library jars directly to your project and adding it to your pom.xml. This is what will be covered in the next sections.
But once completed your pom.xml will essentially contain these
<dependency>
<groupId>com.ey</groupId>
<artifactId>etaf-step-definitions</artifactId>
<version>1.1.1</version>
</dependency>
<dependency>
<groupId>com.ey</groupId>
<artifactId>etaf-core-library</artifactId>
<version>1.1.1</version>
</dependency>
<dependency>
<groupId>com.ey</groupId>
<artifactId>license-validator</artifactId>
<version>1.0.7</version>
</dependency>
<dependency>
<groupId>com.ey</groupId>
<artifactId>etl-step-definitions</artifactId>
<version>1.0.2</version>
</dependency>
<dependency>
<groupId>com.ey</groupId>
<artifactId>etl-core-libraries</artifactId>
<version>1.0.3</version>
</dependency>Uncomment the tags above if you have downloaded the dependency jars and are storing them under src/main/resources/JARs/ folder of your project
Note: Don't panic if you do not see xxx-core-library dependencies. As long as you find xxx-step-definitions, its libraries will already be included. You are covered.
Inside EY Network
Within EY Testing I&A, we use GitHub as our tool of choice for version control and collaborative programming. If you are unfamiliar with Git and have not used GitHub before, you must review the GitHub user guides here: https://guides.github.com/
If you are tasked with working on any internal development, get access to our ey-advisory-technology-testing organization within GitHub. Refer the link for directions
- Once inside the organization, you need to navigate to the NGTP project and click on the
Code button.
- Select SSH option and Copy the SSH URL from the GitHub project’s web page
- Open IntelliJ and then do a
File -> New -> Project from Version Control
- Paste the URL in the modal dialog that pops open and hit clone.
- If you have setup your installation prerequisites correctly (SSH, Settings file, environment variables etc.) you should see that the dependencies will auto-resolve and the project will build smoothly.
- And your pom.xml will contain the
com.ey dependencies
Trouble-shooting hints:
- If you are prompted to select a Project SDK, then open
File -> Project Structure. In the left pane, select Project Settings -> Project and select the installed JDK from the Project SDK drop down.
Note: The same process of cloning the project can also be done using GitHub desktop. Read its documentation for that.
Inside Client Network
This will be a little different than what we do internally. Here we need to migrate approved components of NGTP to the client systems. We recommend a single person migrating the NGTP to client network, setting it up, committing and pushing to their version control software. Other team members who intend to use the NGTP can pull it from the VCS.
Migrating key software to client network
- Once inside our ey-advisory-technology-testing organization, you need to navigate to the NGTP project.
- Mirror the repository to create an ngtp-. Refer steps in GitHub Guidelines
- Now that we have established a repository for your specific client work, this will serve as the key connection between your client work and EY NGTP.
- Open the ngtp- project and click on the
Code button.
- Click
Download as zip button and download it to your folder. Let's call that folder to-client.
- Obtain a license file from one of our license administrators, stating the business reason and giving the engagement end date. Every person who is intending to setup and use NGTP must obtain their license.
- Add your license file to your migration folder above.
- Zip the entire contents and open Media Shuttle from your browser
- Attach the zipped folder and send it to your EY email address (Yes, EY email address. This will be obvious in the next couple of steps). Wait for confirmation email from portals@mediashuttle.com
- Now, Open your client laptop and navigate to the same Media Shuttle link.
- Login with your EY credentials as this is limited to EY employees and contractors (This is the reason we sent the files to EY email address)
- Once inside, click on the
My Transfers button on the top right of the ribbon.
- Download the zip folder you sent to yourself.
- Unzip the contents and save the license file to a secure location in your system.
- Unzip the NGTP to a location of your preference.
Setting up the pre-requisites
Follow the steps outlined in the installation prerequisites page
Setting up the NGTP
- Open IntelliJ and
File -> New -> Project from Existing Sources and browse and select the pom.xml file inside the NGTP folder unzipped above.
- You will be prompted with a message box.
- Click the
Open as a Project button
- If you have setup your installation prerequisites correctly (SSH, Settings file, environment variables etc.) you should see that the dependencies will auto-resolve and the project will build smoothly.
Note: It is recommended that no matter how you choose to download your repository (GitHub
Desktop, IntelliJ integration, or simply downloading from GitHub) that you connect your
repository to GitHub Desktop to take advantage of the UI when merging. You can add any
downloaded GitHub project stored on your computer to GitHub Desktop by clicking file/add
a local repository and then pathing to that repository’s location on your computer
Important
- All users of NGTP must have knowledge of GitHub before being granted a license.
Learning to use GitHub desktop and the IntelliJ GitHub plugin are key to keeping a healthy and maintainable code base.
NGTP User Interface
Product Summary
The Next Gen Testing Platform UI is a desktop application which can be set up with user’s existing NGTP (also known as Next Gen Testing Platform) project to allow them to design, execute and report test cases from a UI interface instead of having to use a developer-centric IDEs like Eclipse, IntelliJ etc.
This product is a cross platform desktop application that is easy to install and intuitive to work with.
Minimum System Requirements
- OS: Windows 10 or macOS
- RAM: 8 GB
- Disk Space: 1GB
Software Requirements
Setup Instructions
- Follow all steps to set up any version of Next Gen Testing Platform framework (including setting up Java and Maven as defined in the document) – Windows Next-Gen Testing Platform Installation Procedure
- Use the installer “NGTP Setup 0.0.1.exe” to set up the UI application
- Your antivirus may flag this installation. Please ignore the warnings and allow the installation to proceed
- Open the NGTP.exe file
- Once the above application is open, go to Settings > Path and make sure that the correct back-end framework is selected
Product Understanding
What the UI is
- The UI is a supplement on top of existing BDD framework, so testers need not deal with a Developer IDE
- It can create new tests and execute tests that exist
What the UI is not
- It is not a replacement for a test automation framework
- It is not a coding platform to develop new business code that does not exist in your framework
Scope for MVP
NGTP UI has four tabs, each having the following functionality:
Dashboard
Dashboard tab is landing page for our application. First time users need to select their default framework directory before using any other tab or features available. Dashboard, as the name implies, is available to present the user with information and shows the reports available in the framework from previous test runs.
- User can load test reports and view reports for previous runs
- User can download all reports
Test Design
Test Design tab is place where users can create their own steps and scenarios under feature files. Users can also edit available features from the chosen framework workspace. The tab is split into three sections- Feature files (Left menu). Canvas area (middle) and Page objects (right menu)
Feature File - Create/Upload/Edit
- User can select any project (Henceforth referred to as workspace) to work on. This will be the project name from NGTP framework (e.g. AmazonDemo, PolicyCenter etc.)
- User can directly upload valid feature files
- User can create a new feature file in the canvas and save it
- User can load an existing feature file to the canvas to edit it
Building a Scenario
- User can add, delete or edit Scenarios within the canvas or clear the canvas itself
- User can search the list of Step Definitions in the left menu and add a step definition to the scenario
- User can rearrange, delete added steps
- User can add names to the feature and/or scenarios
- User can add any tags to the Scenarios
- User can switch to raw mode to edit the feature file as raw text
- User can switch from raw mode back to UI mode (only if its tested before UAT)
- Once a step is added to the scenario, users can fill-in data to the empty input boxes either by typing a value or by dragging and dropping data from the right pane. The data can either be a test data (e.g. Addresses, names etc.) or a screen element (e.g. Submit button, username text box)
Execute
Execute tab is the place where users can execute feature files that already exists in the project or created in the Design tab. Users can choose the scenarios from the feature files explorer section, with the help of search and filter functionality. There is a Run configuration drop down area where users can change basic and most used test configurations that are available in settings tab.
- User can select a workspace to work on. This will be the project name from NGTP framework
- User can select one or multiple feature files from the left menu to add them to the canvas area
- User can select any combination of scenarios to run from the canvas area
- User can change basic settings from Run Configuration menu
- User can execute selected scenarios. The results will be available in the Dashboard tab
Settings
Settings tab is the space where users can configure the settings needed for the framework. It contains 8 sub-tabs or sections categorized based on functionality.
- In the settings tab, a user is presented with all the available settings in Next Gen Testing Platform
- User can choose to reset all settings which will change all settings back to default values
Assumptions
- The UI application is dependent on a working test automation framework
- Product can only recognize step definitions if they are in a java file ending with “StepDefinitions.java”
- Application can only read from and save feature files in the default features folder for the workspace - ~src/test/resources/{workspace}
- Some step definitions may not get recognized by the UI and send an error “Invalid Step in the file” if their regular expression is not supported. This will be fixed as the framework gets updated
- Product assumes default location of Step Definitions and Reusable Step Definitions based on Next Gen Testing Platform architecture as follows:
- Reusable Step Definitions -
~src/main/java/seleniumutils/reusablestepdefinitions
- Step Definitions-
~src/test/java/{workspace}/stepdefinitions
This will change in the next release where we can configure paths to custom step definitions
Limitations
As this is the MVP release, the product has a few limitations and assumptions:
- Product does not support API and ETL tests
- Product does not support Scenario Outlines and Examples
- Product does not support creating new Test Data or Page Objects
- Product does not support creating new Step Definitions
- To see all reports, leave the reports location blank in settings. Alternatively, selecting a specific html report in the Reports Location will load just this one report on the dashboard
- If a Feature contains a Step Definition that is not recognized, the feature file will not load on the canvas
Definitions/glossary
Feature file
Automation tests in the UI are created using Feature Files. Features files contain a list of scenarios composed of Steps written in Gherkin language which provides a way to describe your application behavior in business readable language. Each feature can have one or more scenarios, and every scenario consists of one or more steps.
Scenario
Every Scenario is an individual test case. Scenario is one of the core Gherkin structures. Every scenario starts with the keyword “Scenario:” (or localized one) and is followed by an optional scenario title. Every scenario consists of a list of steps, which must start with one of the keywords Given, When, Then, But or And.
Step or Step Definition
A step definition is a common template for a step. E.g. Given I navigate to “__”. Here you can fill any valid URLs.
A Step Definition links the java code to one or more Gherkin steps. When Cucumber executes a Gherkin step in a scenario, it will look for a matching step definition to execute.
You can use tags to group features and scenarios together, independent of your file and directory structure. This allows you to run multiple tests at once.
FAQs
Q. I don’t see anything loading in the UI
A. Go to Settings>Paths and make sure that the back-end framework’s path is selected. When you click browse, the selected folder should show “src” directory and “pom.xml”
Q. Nothing loads on the dashboard or unexpected report loads
A. Go to Settings>path and make sure the path for reports is empty if you want the default reports to load or select a specific report (index.html) for it to be loaded on dashboard
Q. I selected a specific report and now I can’t clear the path to load the default view
A. To clear the path, you will have to go to Settings and click on “Reset Settings” button. Please note, this will also reset all other settings
Q. The notification says “Test execution completed” but I do not see the updated report
A. This happens if there was an error in executing the tests after build was run successfully. Make sure your back-end framework is set up correctly by running command:
mvn clean install to see if all default testsmvn clean install -Dsource.feature="<path of the folder where your feature files are located> " -Dapplication="<applicationName>" -Denvironment="<environment name>
If any one of the above commands fail, you may need to update the back-end framework’s POM.xmlQ. I don’t know what Page Objects or Test Data values are supposed to be used when I design tests
A. This is a limitation of the UI application and we assume that the person designing tests either knows the values in Page Objects and Test Data or can edit them in the back-end frameworkQ. I made some changes and added feature files directly in the back-end but I do not see them in the UI
A. To reload the list of feature files, please switch the workspace and switch back to your workspace. You will find that the list of feature files is updatedQ. I cannot uninstall the application using the uninstaller.exe
A. This is a known issue as the uninstaller is flagged and quarantined by EY’s antivirus. Please uninstall the application by going to Control Panel > Programs > Uninstall a Program, then look for NGTP application and double click on it. Now you can follow the on-screen prompts to uninstall the application
List of NGTP Libraries
This page describes the list of features and capabilities supported by Next Gen Testing Platform
- Web Application Test Automation
- API/Microservices Test Automation
- ETL/Data Validation Automation
- PDF/ Document Validations
- Mobile Test Automation (upcoming)
- Accessibility Test Automation (Upcoming)
Third-Party Integrations
NGTP is built modularly and it can support a whole lit of java libraries. If its a java library, it works with NGTP. If the library is hosted in a Central repository like maven you can simply copy/paste its dependency in the pom.xml under <dependencies></dependencies>
Test Containerization
NGTP supports Docker/Kubernetes based test containerization and distributed parallel execution. Here is how you will do it.
Azure DevOps
NGTP can be deployed to Azure Devops as easily as it can be pushed to a GitHub repository. Here is how you will do it.
Report Portal
Report portal is an AI powered Test Automation Dashboard. It can:
- One-place dashboard
- Analyze results
- Live-streaming of results
- Defect traceability and automated issue-bucketing
- Visualization
Here is how you will do it.
Setting up CI Pipelines
- The Trunk master branch will have a CI pipeline setup using CircleCI to make sure every PR is
tested before merged.
- Once your Fork is setup, You can add CI pipelines to automate the build process using
CircleCI as below:
GitHub Usage Guidelines
Setting Up Your GitHub Account
- First go to www.github.com and create a free account using your EY email (must use EY email in order to gain access to the EY GitHub organization)
- After you create/own a GitHub account, an owner/admin of the EY advisory technology testing GitHub organization will be able to send you an email that looks like this:
- Once you click to join you will be prompted to set up two-factor authentication. As a security measure we are requiring two-factor authentication be set up on a registered EY device (i.e. a phone with EY email enabled and all necessary security measures to enable EY email set up)
- In order to avoid frequent login, users may set up a personal security key with your GitHub account
- The process to do so is documented on the following page under the title "Configuring two-factor authentication using a security key"
- You will now be able to access the EY advisory Technology Testing repository here https://github.com/ey-advisory-technology-testing
Note: GitHub enterprise licenses are scarce and will only be allotted with a strong business case.
Access to Repositories
- Every member of GitHub will belong to one or more GitHub teams.
- Only the teams will be assigned to projects and will have access to repositories
- Members in turn get access to repositories for which their team is assigned access.
- No individual (except admins and Org. owners) will be directly assigned to a repository.
- Every team in turn needs to enforce proper access controls on individuals(read, write or admin).
- Only team leads get admin access
- Contributors get write access
- Everyone else read access
- For certain confidential and IP-protected repositories, access is strictly controlled and will be based on business justification only.
Creating a New project
Conventions
Naming Repos
- All project names should be in lower case hyphenated form.
- star-wars
- the-empire-strikes-back
- return-of-the-jedi
- Avoid camelCase, title-case, upper-case.
The problem with camel case is that there are often different interpretations of words - for example, checkinService vs checkInService. Also, it is
difficult with auto-completion if you have many similarly named repos to have to constantly check if the person who created the repo you care about
used a certain breakdown of the upper and lower cases. It's also best to avoid upper case, no one likes yelling.
- Avoid organization monikers, jargons and abbreviations unless they are highly popular and familiar to non-technical audience(e.g. SQL, EY)
- Be specific (guidewire-core-library instead of insurance-core-library because we may have other technologies for insurance suite automation later on)
- Once established, it's a simple task to change repo names, BUT it can have unintended consequences like breaking downstream links - so think about a name that can be stable over a long period of time.
Mandatory Contents
README
- All of them should have a detailed README.md created in Markdown
- Brief introduction about the project
- Installation instruction
- If it is intended to be used as JAR dependency, then this section should contain the dependency details or JAR installation details to be able to use it
- If it is intended to be used as a standalone project, then this section should contain the installation instructions to use it.
- Usage
- Detailing the features and capabilities and how to use them
- LICENSE appendix
- Refer NGTP trunk project
GitHub Workflows
- Every project should be built with CICD in mind. IT should contain an actions workflow for Pull Request (PR) approval process and one for release process
License Disclaimer file
- Every project should have an EY License disclaimer file, whether or not it will be taken to client systems.
Cloning your project
- If you are unfamiliar with Git and have not used GitHub before, you can review the GitHub user guides here: https://guides.github.com/
- GitHub can be leveraged in multiple ways, two of the most convenient of which are GitHub desktop and IntelliJ's Git integration
- GitHub desktop is a desktop application created by GitHub that allows the user to exercise all Git operations through a very user friendly and easy to learn UI
- To install GitHub Desktop for free simply download the application here: https://desktop.github.com/
- A comprehensive guide on how to use GitHub desktop can be found here: https://help.github.com/en/desktop
- If you would like to instead use IntelliJ's built in Git capability to manage the installation of your repository, you can open IntelliJ and download your project directly to your IDE by selecting file -> new -> project from version control/git
Copy and paste the clone URL from the GitHub project's web page to your IntelliJ clone window
After hitting clone your project will be downloaded to your local file system
In GitHub, click on the watch drop down button on the top right corner of the project Select Custom -> Releases. This will notify you if there are any new releases in the project. Do this for all the GitHub projects that you need to keep track of. Especially the libraries that NGTP is directly depending on (etaf-helpers, etaf-core-library, etaf-step-definitions etc).
Important
- All users of NGTP must have knowledge of GitHub before being granted a license. Learning to use GitHub desktop and the IntelliJ GitHub plugin are key to maintaining a clean project
Mirroring Repositories
In case you need to use NGTP at your client engagement, you will need to mirror the ngtp-official repository. The steps for that is outlined here. Refer to the first section on mirroring a repository and follow the steps.
- Navigate to the NGTP Official repository .
- In order to ensure repo maintenance, only those with organizational owner roles will be allowed to push to the ngtp-official.
- Product team leaders will instead make a mirror repository based on the ngtp-official for their product team to work on.
- Once you have mirrored the repo you will have full control over your repository and be able to share the repository with your team as long as they are registered members of the EY Advisory Technology Testing GitHub organization (restrictions to organization members and requirement of two-factor authentication will still be enforced through forks, however you can grant your team access to write your project repo)
Repository Settings
Development Guidelines
Code Pulls
All projects within our organization must follow the standards and guidelines outlined below.
- We follow a
pull before push methodology when collaborating in GitHub. It means everyone needs to take updates from the master branch before pushing their on changes. This will minimize merge conflicts and prevent broken code.
- We recommend taking a pull/updating your project as often as possible (depending on how frenetic development in your repository is)
Code Pushes and PR process
Ensure you have taken an update before you begin working on pushing the code back to GitHub.
Merging useful code back to the NGTP Trunk
During the course of the project, the team might create tools, libraries or methods that could be a value add for our NGTP. This is one of the key ways NGTP can grow as a platform, through peer and project contributions.
In case if there are such candidates to be incorporated into the trunk, cut a branch called release. In IntelliJ, switch to that release branch and create a PR to the Trunk. It will be reviewed by the NGTP admins and if approved will be merged into the Trunk.
Keeping your projects in sync and up-to-date with Trunk
For everyone who is using NGTP at the client location and whoever needs to subscribe to all the updates from NGTP, please follow the below steps to subscribe to the NGTP release. This step needs to be performed for all our EY libraries used by your project. The list of libraries can be obtained from your pom.xml. Look for any dependency that says com.ey.
e.g
<dependency>
<groupId>com.ey</groupId>
<artifactId>etaf-step-definitions</artifactId>
<version>1.1.3</version>
</dependency>
<dependency>
<groupId>com.ey</groupId>
<artifactId>etl-step-definitions</artifactId>
<version>1.0.4</version>
</dependency>Whenever there is an update or a release notification to any of these repositories, if you are within EY network,
update the corresponding dependency version in your project's pom.xml to take the latest update. If you are within the client network, follow the steps outlined in Installing NGTP at client network to get your project updated.
Product Versioning
We will be following the below versioning strategy for our projects.
Important
- .. e.g. 1.0.1 meaning 1st patch release after the 1st major release.
- Every time, a major integration is added, update the major version number and push.
- Every time you add a significant change or added new capability, update the minor version number and push.
- For every other push to any project update the patch number.
Product Versioning
- We will be following the below versioning strategy for our projects.
- Important
- .. e.g 1.0.0 (meaning 1st Major release with no minor
updates or patches/fixes.
- Every time, a major integration is added, update the major version number and
push.
- Every time you add a significant change or added new capability, update the
minor version number and push.
- For every change pushed to master after a release let us update the patch
number.
- What constitutes a release? – We will have 2 releases per year. Once every 2 quarters.
If we have substantial changes, we will update to a new release version and
communicate to all forks to update to the latest release
- All code will be required to be merged to the trunk-master on a monthly basis.
Reminder emails for these merges as well as any other necessary merges that come up
will be sent in advance and a calendar of these planned merges will be hosted on
SharePoint here
- The initial move to GitHub and new code management strategy will take some effort
and cooperation on all our parts at the beginning, but should improve both the rate at
which we are able to internally develop new tools and the stability of our product
teams’ engagement branches moving forward
Framework Troubleshooting
Issue: Repository blocked from downloading
If download of repository is blocked due to any restrictions, please see the below work arounds in order of convenience:
- Upload framework to GitHub and transfer to client machine
- Zip-up framework and upload to a shared drive for download
- Copy files to notepad and email to client
- Please note that if the workarounds are used manual updates will need to be taken from the central repository.
- If framework is not routinely kept up to date, the practice may not be able to continue supporting the framework.
Below please find the steps to fix the issue:
- File -> Settings -> Plugins
- Uncheck Gradle
- Click Apply
- Restart IntelliJ
- Click Run
Issue: Maven dependencies not downloading
Alternative method 1 (preferred):
If you are unable to download dependencies directly through the pom, you can manually setup maven by copying the .m2 folder from the SharePoint and exporting it to specified location on your laptop or VDI.
SharePoint link: https://sites.ey.com/:u:/s/TestingiCOP/TestAutomation/EbDwXaiL3zRCr1j_X3746U4BJ8UXbFmWcZ63R1nHk4IueQ
Location to unzip to: C:\Users{your_username}
If you are unable to download maven at all, you can send over the following Apache.zip.
SharePoint link: https://sites.ey.com/:u:/s/TestingiCOP/TestAutomation/EZo9K4R-KI1DqJn2kyDL_pQBB5IC5IUfqG7mPyUHfsmUxw
Location to unzip to: C:\Program Files
Alternative method 2:
If you are unable to download dependencies directly through the pom, you can manually download the dependencies listed at the below link from https://mvnrepository.com/.
List of dependencies:
https://sites.ey.com/:w:/s/TestingiCOP/TestAutomation/EWSnYPRJ9RxLmDN_lnByUXkBZ0cOUsrbmdQXtsb7Ko8zGg
Steps to manually add maven dependencies as jars:
- Go to https://mvnrepository.com/
- Download all dependencies above as jars
- Open IntelliJ
- File->Project Structure->Modules->Dependencies
- Click +
- Select Jars or directories
- Select Jar file
- Click ok
- Repeat for all dependencies
EY Hosted Dependencies
If the dependencies are from EY like com.ey.xyz refer to the last page in this document about Using GitHub Hosted Dependencies
Issue: Failure on running a scenario (Command length is too long etc.)
- Click Run -> Edit Configurations
- Open the JUnit or TestNG Configuration you were running
- On the right side look for the drop-down,
`Shorten Command Line:'
- From the drop down select the last option:
@argfile (Java 9+) - java @argfile classname [args]
